Meshtastic App/com.geeksville.mesh/[androidJvm]ModuleConfigProtos/ModuleConfig/ExternalNotificationConfigOrBuilder

ExternalNotificationConfigOrBuilder

interface ExternalNotificationConfigOrBuilder : MessageOrBuilder

Inheritors

Functions


IF this is true, the 'output' Pin will be pulled active high, false
means active low.

bool active = 4;

getAlertBell

abstract fun getAlertBell(): Boolean


True: Alert when the bell character is received (output)

bool alert_bell = 6;

getAlertBellBuzzer

abstract fun getAlertBellBuzzer(): Boolean


True: Alert when the bell character is received (output_buzzer)

bool alert_bell_buzzer = 13;

getAlertBellVibra

abstract fun getAlertBellVibra(): Boolean


True: Alert when the bell character is received (output_vibra)

bool alert_bell_vibra = 12;

getAlertMessage

abstract fun getAlertMessage(): Boolean


True: Alert when a text message arrives (output)

bool alert_message = 5;

getAlertMessageBuzzer

abstract fun getAlertMessageBuzzer(): Boolean


True: Alert when a text message arrives (output_buzzer)

bool alert_message_buzzer = 11;

getAlertMessageVibra

abstract fun getAlertMessageVibra(): Boolean


True: Alert when a text message arrives (output_vibra)

bool alert_message_vibra = 10;

getEnabled

abstract fun getEnabled(): Boolean


Enable the ExternalNotificationModule

bool enabled = 1;

getNagTimeout

abstract fun getNagTimeout(): Int


The notification will toggle with 'output_ms' for this time of seconds.
Default is 0 which means don't repeat at all. 60 would mean blink
and/or beep for 60 seconds

uint32 nag_timeout = 14;

getOutput

abstract fun getOutput(): Int


Define the output pin GPIO setting Defaults to
EXT_NOTIFY_OUT if set for the board.
In standalone devices this pin should drive the LED to match the UI.

uint32 output = 3;

getOutputBuzzer

abstract fun getOutputBuzzer(): Int


Optional: Define a tertiary output pin for an active buzzer
This is used in standalone devices to to match the UI.

uint32 output_buzzer = 9;

getOutputMs

abstract fun getOutputMs(): Int


When using in On/Off mode, keep the output on for this many
milliseconds. Default 1000ms (1 second).

uint32 output_ms = 2;

getOutputVibra

abstract fun getOutputVibra(): Int


Optional: Define a secondary output pin for a vibra motor
This is used in standalone devices to match the UI.

uint32 output_vibra = 8;

getUseI2SAsBuzzer

abstract fun getUseI2SAsBuzzer(): Boolean


When true, enables devices with native I2S audio output to use the RTTTL over speaker like a buzzer
T-Watch S3 and T-Deck for example have this capability

bool use_i2s_as_buzzer = 15;

getUsePwm

abstract fun getUsePwm(): Boolean


use a PWM output instead of a simple on/off output. This will ignore
the 'output', 'output_ms' and 'active' settings and use the
device.buzzer_gpio instead.

bool use_pwm = 7;